Release 10.1A: OpenEdge Development:
Progress 4GL Reference

PUT-KEY-VALUE statement

Adds, modifies, and deletes keys in the current environment.

Note: Does not apply to SpeedScript programming.

Syntax

PUT-KEY-VALUE { { SECTION section-name KEY { key-name | DEFAULT } VALUE value } | { COLOR | FONT } { number | ALL } } [ NO-ERROR ]

SECTION section-name

A CHARACTER expression that specifies the name of the section that contains the key of interest.

In initialization files, section names appear in square brackets([]). When you specify a section name in a PUT-KEY-VALUE statement, omit the square brackets.

KEY key-name

A CHARACTER expression that specifies the name of the key of interest.

DEFAULT

Tells PUT-KEY-VALUE to use the default key of section section-name.

Some applications store data in the registry under the default key of a section. This option lets you modify this data. For an example, see the EXAMPLES section of this entry.

This option applies only to the registry and not to initialization files.

VALUE value

The value of the key to write to the environment. value must evaluate to a CHARACTER expression of no more than 128 bytes.

COLOR { number | ALL }

Updates color definitions in the current environment from the definitions in the internal color table. The number parameter is a literal integer that specifies the number of a single color in the current environment whose definition you want to update. The ALL option updates all color definitions in the current environment.

FONT { number | ALL }

Updates font definitions in the current environment from the definitions in the internal font table. The number parameter is a literal integer that specifies the number of a single font in the current environment whose definition you want to update. The ALL option updates all font definitions in the current environment.

NO-ERROR

Specifies that any errors that occur as a result of the PUT-KEY-VALUE operation are suppressed. After the PUT-KEY-VALUE statement completes, you can check the ERROR-STATUS system handle for information on any errors that might have occurred.

Examples

If the current environment resides in the registry, the following example:

Searches in the registry under the current environment for the subkey MYSECTION.
Creates MYSECTION if it does not exist.
Searches MYSECTION for the subkey MYKEY.
Sets MYKEY to the value MYVARIABLE (if MYKEY exists),
or adds MYKEY and the value MYVARIBLE (if MYKEY does not exist).

If the current environment resides in an initialization file, the following example:

Searches the initialization file for the section MYSECTION.
Creates MYSECTION if it does not exist.
Searches MYSECTION for the key MYKEY.
Sets MYKEY to the value MYVARIABLE (if MYKEY exists),
or adds MYKEY and the value MYVARIBLE (if MYKEY does not exist):

PUT-KEY-VALUE SECTION "MYSECTION" KEY "MYKEY" VALUE MYVARIABLE

If the current environment resides in the registry, the following examples add, directly under the current environment, the value name MYKEY and the value MYVARIABLE.

If the current environment resides in an initialization file, the following examples return an error:

PUT-KEY-VALUE SECTION "" KEY "MYKEY" VALUE MYVARIABLE

PUT-KEY-VALUE SECTION "?" KEY "MYKEY" VALUE MYVARIABLE

If the current environment resides in the registry, the following examples:

Search in the registry under the current environment for the key MYSECTION.
Search MYSECTION for the value name MYKEY.
Delete MYKEY and its value.

If the current environment resides in an initialization file, the following examples delete the key MYKEY, including its value, from the section MYSECTION.

PUT-KEY-VALUE SECTION "MYSECTION" KEY "MYKEY" VALUE ""

PUT-KEY-VALUE SECTION "MYSECTION" KEY "MYKEY" VALUE ?

If the current environment resides in the registry, the following examples delete the subkey MYSECTION, all values under MYSECTION, all subkeys under MYSECTION, and all values under those subkeys.

If the current environment resides in an initialization file, the following examples remove the section MYSECTION, and all key-value pairs within MYSECTION, from the initialization file:

PUT-KEY-VALUE SECTION "MYSECTION " KEY "?" VALUE ?

PUT-KEY-VALUE SECTION "MYSECTION " KEY "" VALUE ""

If the current environment resides in the registry, the following example:

Searches the current environment for the subkey MYAPP.
Sets the default key under MYAPP to NEWVALUE.

If the current environment resides in an initialization file, the following example returns an error.

PUT-KEY-VALUE SECTION "MYAPP" KEY DEFAULT VALUE "NEWVALUE"

Notes

Environments typically consist of sections, each of which contains keys, each of which consists of a name and a value. A typical section name is COLORS. A typical key within this section consists of the name COLOR7 and the value 255,255,0. This key attaches the name COLOR7 to color value 255,255,0 (a color specification that uses the red-green-blue color-naming scheme).

The current environment might be the registry or an initialization file. The registry consists of sections called keys and subkeys arranged in a hierarchy. Keys and subkeys contain value entries, each of which consists of a value name and value data. Initialization files, by contrast, consist of a single level of sections. Sections contain entries, each of which consists of a name, an equal sign (=), and a value.

For more information on environments, see the chapter on colors and fonts in OpenEdge Development: Programming Interfaces .

The current environment is one of the following:
The default environment.
An environment that a startup parameter specified (This environment is called the startup environment).
An environment that a LOAD statement loaded and that the most recent USE statement made current.
If you UNLOAD the current environment, a subsequent PUT-KEY-VALUE writes to the startup environment.
To remove a key-value pair from an environment, set key-name to the name of the key and value to the Unknown value (?).
To remove a section, including all its key-value pairs, from an environment, set section-name to the name of the section and key-name to the Unknown value (?).
To change the definitions in the internal color table, use one of the following techniques:
To display a dialog box that lets the user change the color definitions, use the SYSTEM-DIALOG-COLOR statement.
To change the color definitions directly from the 4GL, use the attributes and methods of the COLOR-TABLE handle.
Note: The COLOR option of the PUT-KEY-VALUE statement does not change the definitions in the internal color table. This option merely moves some or all of those definitions to the current environment.

To change the definitions in the internal font table, use one of the following techniques:
To display a dialog box that lets the user change the font definitions, use the SYSTEM-DIALOG-FONT statement.
To change the font definitions directly from the 4GL, use the attributes and methods of the FONT-TABLE handle.
Note: The FONT option of the PUT-KEY-VALUE statement does not change the definitions in the internal font table. This option merely moves some or all of those definitions to the current environment.

For more information on colors and fonts, see the chapter on colors and fonts in OpenEdge Development: Programming Interfaces .

See also

COLOR-TABLE system handle, FONT-TABLE system handle, GET-KEY-VALUE statement, LOAD statement, SYSTEM-DIALOG COLOR statement, SYSTEM-DIALOG FONT statement, UNLOAD statement, USE statement